Skip to content

docs: Section on community use and contribution#26

Merged
sbillinge merged 10 commits into
diffpy:mainfrom
cadenmyers13:cmi-functionality
Jul 29, 2025
Merged

docs: Section on community use and contribution#26
sbillinge merged 10 commits into
diffpy:mainfrom
cadenmyers13:cmi-functionality

Conversation

@cadenmyers13

Copy link
Copy Markdown
Contributor

Added a small section to index.rst that informs people that they can contribute to diffpy.cmi. @sbillinge Let me know your thoughts on the figure. The idea is that the community can fill in the empty/gray circles with their own modules.

Screenshot 2025-07-29 at 2 01 07 PM

@codecov

codecov Bot commented Jul 29, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.67%. Comparing base (d215a47) to head (203ca14).
⚠️ Report is 24 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #26   +/-   ##
=======================================
  Coverage   75.67%   75.67%           
=======================================
  Files           3        3           
  Lines          37       37           
=======================================
  Hits           28       28           
  Misses          9        9           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge

Copy link
Copy Markdown
Contributor

I like the figure! We do actually have a SAS module, at least we need to get it going again but it is developed. We actually have an EXAFS module too but we never implemented it as we didn't think it was that useful. But for the purposes of the figure, adding a SAS module makes it look a bit more encouraging if people do want to contribute..... What do you think?

There is a paper describing the sas... https://journals.iucr.org/paper?S1600576713034055

@sbillinge sbillinge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking really great! Please see my comments

Comment thread doc/source/index.rst Outdated
Comment thread doc/source/index.rst Outdated
Comment thread doc/source/index.rst
@cadenmyers13

Copy link
Copy Markdown
Contributor Author

What do you think?

@sbillinge Yeah I agree with adding these to the figure! I'll try to configure it and ping you when done!

@cadenmyers13

Copy link
Copy Markdown
Contributor Author

@sbillinge How does this look?

Screenshot 2025-07-29 at 3 35 50 PM

@sbillinge sbillinge merged commit b3a799c into diffpy:main Jul 29, 2025
5 checks passed
@sbillinge

Copy link
Copy Markdown
Contributor

love it!

@cadenmyers13 cadenmyers13 deleted the cmi-functionality branch October 28, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants